package cn.jw.starter.swagger.core;

import org.springframework.boot.context.properties.ConfigurationProperties;

import lombok.Data;

/**
 * swagger的参数配置类
 *
 * @author 王广帅
 * @since 2024/4/7 23:17
 */

@ConfigurationProperties(prefix = "jw.swagger")
@Data
public class JwSwaggerProperties {

    /**
     * 是否开启swagger，默认是false
     */
    private boolean enable = false;
    /**
     * 标题
     */
    private String title;
    /**
     * 描述
     */
    private String description;
    /**
     * 作者
     */
    private String author;
    /**
     * 版本
     */
    private String version;
    /**
     * url
     */
    private String url;
    /**
     * email
     */
    private String email;

    /**
     * license
     */
    private String license;

    /**
     * license-url
     */
    private String licenseUrl;
    /**
     * swagger显示api匹配的地址路径
     */
    private String[] swaggerMatchPathList;
    /**
     * 要排除的路径列表，被排除的请求接口不会显示的swagger的ui界面上面
     */
    private String[] swaggerExcludePathList;
}
